Salesforce UX API
TMF-639 POST Create Device (Akamai)
This API is used to perform below two use cases
- Create Device in Akamai system
- Delete device in Akamai system
==> POST Create Device (Akamai)
URL
https://[localhost]:[port]/sfdc-ux/v1/{businessId}/resourceuri Param
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | Y |
Header
| name | type | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request | Y |
| X-Asavie-Account-Id | string | Id of the account to operate in | Y |
| operation | string | Operation to be performed | Y |
cURL request
curl --location 'https://nonprod.esb.cloud.lla.com/dev/sfdc-ux/sfdc-ux/v1/PR/resource' \
--header 'X-Asavie-Account-Id: 98f94216-0b69-47bc-ac5c-79ddfb18acc3' \
--header 'X-Correlation-ID: 100425' \
--header 'operation: POST_DEVICE_AKAMAI' \
--header 'Content-Type: application/json' \
--header 'client_id: 12345' \
--header 'client_secret: abcde' \
--data-raw '{
"name": "test device name45",
"resourceCharacteristic": [
{
"name": "email",
"value": "email@email.com"
},
{
"name": "phone_number",
"value": "+23556891"
}
],
"activationFeature": [
{
"featureCharacteristic": [
{
"name": "apn_id",
"value": "liberty_pr"
},
{
"name": "interface_type",
"value": "apn"
},
{
"name": "sim_number",
"value": "+12467732596"
},
{
"name": "sim_number_type",
"value": "msisdn"
}
]
}
]
}'Definitions
Each of the request parameters is detailed.
Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| name | string | name of the device | Y |
| resourceCharacteristic | array | A list of resource characteristics | N |
| resourceCharacteristic[].name | string | Note : Possible resourceCharacteristic names are : email = Email used to send messages to non SMS capable devices phone_number = Phone number used to send messages for SMS capable devices | N |
| resourceCharacteristic[].value | string | value of characteristics | N |
| activationFeature | array | Array of the interfaces of the device | N |
| activationFeature[].featureCharacteristic | array | A list of characteristics | N |
| activationFeature[].featureCharacteristic[].name | string | Note : Possible featureCharacteristic names are : apn_id interface_type sim_number sim_number_type | N |
| activationFeature[].featureCharacteristic[].value | string | value of characteristic | N |
Response
{
"name": "test device name45",
"resourceStatus": "activating",
"id": "0c5f1ef3-cb87-4c7d-b8b9-79d10202a462",
"resourceCharacteristic": [
{
"name": "account_id",
"value": "98f94216-0b69-47bc-ac5c-79ddfb18acc3"
},
{
"name": "policy_group_id",
"value": "fa878225-b0ff-41b3-b8e2-ce806b82adc5"
},
{
"name": "created_date",
"value": "2025-06-13T14:42:18.4938704Z"
},
{
"name": "device_os",
"value": null
},
{
"name": "email",
"value": "email@email.com"
},
{
"name": "phone_number",
"value": "+23556891"
},
{
"name": "billable",
"value": true
},
{
"name": "imeis",
"value": []
}
],
"activationFeature": [
{
"featureCharacteristic": [
{
"name": "apn_id",
"value": "liberty_pr"
},
{
"name": "interface_type",
"value": "apn"
},
{
"name": "name",
"value": null
},
{
"name": "sim_number",
"value": "+12467732596"
},
{
"name": "sim_number_type",
"value": "msisdn"
},
{
"name": "id",
"value": "86c0d1db-4e56-4369-80dd-666100029564"
},
{
"name": "account_id",
"value": "98f94216-0b69-47bc-ac5c-79ddfb18acc3"
},
{
"name": "enabled",
"value": true
},
{
"name": "network_id",
"value": "bedb77c2-c1ee-4481-9bee-6ae1472f4a6c"
},
{
"name": "policy_group_id",
"value": "fa878225-b0ff-41b3-b8e2-ce806b82adc5"
},
{
"name": "status",
"value": "activating"
},
{
"name": "created_date",
"value": "2025-06-13T14:42:18.5072006Z"
},
{
"name": "sku",
"value": "SDEDG003"
},
{
"name": "metadata",
"value": {}
},
{
"name": "billing.billable",
"value": true
},
{
"name": "iccid",
"value": null
},
{
"name": "icc_id",
"value": null
},
{
"name": "cellular_ip",
"value": null
},
{
"name": "lock_imei",
"value": false
},
{
"name": "locked_imei",
"value": null
},
{
"name": "last_connected_mobile_network",
"value": null
}
]
}
],
"resourceRelationship": [
{
"relationshipType": null,
"resource": {
"resourceCharacteristic": [
{
"name": "status",
"value": null
},
{
"name": "status_updated_date",
"value": null
},
{
"name": "device_type",
"value": null
},
{
"name": "device_os",
"value": null
},
{
"name": "os_version",
"value": null
},
{
"name": "app_version",
"value": null
},
{
"name": "invite.code",
"value": null
},
{
"name": "invite.expiry_date",
"value": null
},
{
"name": "invite.qr_code_url",
"value": null
},
{
"name": "app_info.last_launched_at",
"value": null
},
{
"name": "app_info.updated_at",
"value": null
},
{
"name": "cellular.status",
"value": null
},
{
"name": "cellular.updated_at",
"value": null
},
{
"name": "push_notifications.status",
"value": null
},
{
"name": "push_notifications.push_token",
"value": null
},
{
"name": "push_notifications.updated_at",
"value": null
},
{
"name": "vpn.bearer",
"value": null
},
{
"name": "vpn.status",
"value": null
},
{
"name": "vpn.interface_id",
"value": null
},
{
"name": "vpn.updated_date",
"value": null
},
{
"name": "wifi.status",
"value": null
},
{
"name": "app_detailswifi.updated_at",
"value": null
},
{
"name": "billable",
"value": true
},
{
"name": "uem.uem_type",
"value": null
},
{
"name": "uem.device_id",
"value": null
},
{
"name": "uem.last_sync_date",
"value": null
}
]
}
}
]
}Definitions
Each of the response parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| name | string | name of the device | N |
| resourceStatus | string | The aggregated status of the device based on the status of its network interfaces | N |
| id | string | id of device | N |
| resourceCharacteristic | array | A list of characteristics | N |
| resourceCharacteristic[].name | string | Note : Possible resourceCharacteristic names are : account_id = account number policy_group_id = The policy group id of the device. created_date = The date this device was added to the system device_os = What OS this device has email = Email used to send messages to non SMS capable devices phone_number = Phone number used to send messages for SMS capable devices billable imeis | N |
| resourceCharacteristic[].value | string | value of characteristic | N |
| activationFeature | array | Array of the interfaces of the device | N |
| activationFeature[].featureCharacteristic | array | A list of characteristics | N |
| activationFeature[].featureCharacteristic[].name | string | Note : Possible featureCharacteristic names are : apn_id interface_type name sim_number sim_number_type id account_id enabled network_id policy_group_id status created_date sku metadata billing.billable iccid icc_id cellular_ip lock_imei locked_imei last_connected_mobile_network | N |
| activationFeature[].featureCharacteristic[].value | string | value of characteristic | N |
| resourceRelationship | array | If the device has the App installed, these are the details. | N |
| resourceRelationship[].relationshipType | string | set the resourceRelationship[].relationshipType as "bundled" | N |
| resourceRelationship[].resource | object | A resource ref or value | N |
| resourceRelationship[].resource{}.resourceCharacteristic | array | A list of characteristics | N |
| resourceRelationship[].resource{}.resourceCharacteristic[].name | string | Note : Possible featureCharacteristic names are : status status_updated_date device_type device_os os_version app_version invite.code invite.expiry_date invite.qr_code_url app_info.last_launched_at app_info.updated_at cellular.status cellular.updated_at push_notifications.status push_notifications.push_token push_notifications.updated_at vpn.bearer vpn.status vpn.interface_id vpn.updated_date wifi.status app_details.wifi.updated_at billable = Billing information for the device uem.uem_type uem.device_id uem.last_sync_date | N |
| resourceRelationship[].resource{}.resourceCharacteristic[].value | string | value of characteristic | N |
Possible response error
In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.
[ 400 ]
Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.
{
"errors" : [{
"code" : 400,
"message" : "The request is invalid or not properly formed.",
"description" : "Malformed request syntax, invalid request message framing, or deceptive request routing."
}]
}[ 401 ]
Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.
{
"errors" : [{
"code" : 401,
"message" : "The user could not be authenticated for this request.",
"description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
}]
}[ 404 ]
Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.
{
"errors" : [{
"code" : 404,
"message" : "The request is invalid or not properly formed.",
"description" : "The requested operation failed because a resource associated with the request could not be found."
}]
}[ 405 ]
Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
{
"errors": [{
"code": 405,
"message": "APIKIT:METHOD_NOT_ALLOWED",
"description": "HTTP Method DELETE not allowed for : /{businessId}/service"
}]
}[ 500 ]
Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.
{
"errors" : [{
"code" : 500,
"message" : "Internal Server Error",
"description": "The request failed due to an internal error"
}]
}[ 501 ]
Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.
{
"errors" : [{
"code" : 501,
"message" : "Not implemented",
"description" : "Operation PATCH /service for Business Id: xxxx not implemented"
}]
}==> DELETE Device (Akamai)
Delete Device in Akamai system
URL
http://[host]:[port]/sfdc-ux/v1/{businessId}/resourceurl Param
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | Y |
| id | string | IMEI Number of the Device | Y |
Header
| name | type | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
| operation | string | Describes type of operation. In this case "deviceAkamai" | Y |
| X-Asavie-Account-Id | string | Id of the account to operate in | Y |
cURL request
curl --location --request DELETE 'https://nonprod.esb.cloud.lla.com/dev/sfdc-ux/sfdc-ux/v1/PR/resource/554566' \
--header 'X-Correlation-Id: test1234' \
--header 'client_id: abcde' \
--header 'client_secret: 12345' \
--header 'operation: deviceAkamai' \
--header 'X-Asavie-Account-Id: sdf-sdf-sdf-sdf544'